**************************
Software Introduction
**************************

DS-PAW is a first-principles density functional computation program within the Device Studio platform, using plane waves as the basis set and employing the projected augmented wave (PAW) method to construct pseudopotentials. This program can be widely applied in the field of materials science to conduct computational research on materials such as metals, semiconductors, insulators, surfaces, magnetic, non-magnetic, and lithium-ion battery materials;
Can accurately predict the electronic distribution of materials; capable of performing calculations such as atomic geometric structure optimization and other functions. This program is stable in performance and has undergone internal testing on millions of cases on Intel and domestic Huawei chips, including various functions and parallel efficiency.

Command Description
====================================

List command list
------------------------------------

- -lic_
- -info_
- -example_
- -ipp_
- -mpi_
- -mpiargs_
- -pob_

--------------------------------------------------------------------------------------------------------------------------------------------


detail command description
----------------------------------

.. _lic:

***Command Name:** :guilabel:`-lic`

***Usage:** :guilabel:`-lic` is used to generate a serial number. Execute the command :guilabel:`DS-PAW -lic` in the DS-PAW installation directory to obtain the LicenseNumber.txt file, which is used for license application.


---------------------------------------------------------------------------------------------------------------------------------------------

.. _info:

***Command Name:** :guilabel:`-info`

***Usage:** :guilabel:`-info` is used to view software copyright information, execute command: :guilabel:`DS-PAW -info`


---------------------------------------------------------------------------------------------------------------------------------------------

.. _example:

***Command Name:** :guilabel:`-example`

***Usage:** :guilabel:`-example` is used to quickly perform a single calculation, which can check if DS-PAW is installed correctly. Execute the command: :guilabel:`DS-PAW -example`


---------------------------------------------------------------------------------------------------------------------------------------------

.. _ipp:

***Command Name:** :guilabel:`-ipp`

***Usage:** :guilabel:`-ipp` is used to view the DS-PAW pseudopotential data information, including the cutoff energy, valence electron number, etc. Execute the command: :guilabel:`DS-PAW -ipp`


---------------------------------------------------------------------------------------------------------------------------------------------

.. _mpi:

***Command Name:** :guilabel:`-mpi xxx`

***Usage:** :guilabel:`-mpi` is used to specify the location of the mpi execution program, such as: :guilabel:`-mpi mpirun`



---------------------------------------------------------------------------------------------------------------------------------------------

.. _mpiargs:

***Command Name:** :guilabel:`-mpiargs xxx`

***Usage:** :guilabel:`-mpiargs` is used to specify MPI runtime arguments, such as :guilabel:`-mpiargs "-np 16"`


-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

.. _pob:

***Command Name:** :guilabel:`-pob`

***Usage:** :guilabel:`-pob` is used to reasonably allocate the number of cores for parallel computing to speed up the run, short for *parallel over band*, and can be added to the submission command. DS-PAW cannot enable pob in some functional calculations, and will issue a warning and turn off pob in this case

------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------



.. _1.3 程序运行:

run program running
====================


submit command to submit execution
----------------------------------

Set environment variables:

.. code-block:: bash

    export PATH={DS-PAW INSTALLPATH}/bin:$PATH


Serial execution:

.. code-block:: bash

    DS-PAW input.in

Parallel execution:

.. code-block:: bash

    DS-PAW -mpi mpirun -mpiargs "-np 16" input.in -pob

Submit the script to run
----------------------------------

If using a queuing system (such as PBS, Slurm, etc.) to submit tasks, as long as the corresponding ``.pbs`` or ``.slurm`` scripts are configured, you can submit tasks using :guilabel:`qsub xx.pbs` or :guilabel:`sbatch xx.slurm`.